FEXPFileHandler.h

Go to the documentation of this file.

// © FEXP, FEXPEnterprise Solver, Ing. Vaclav Rek
// Library for file handling.
// Compiler must support C++ ver.14 and later
#ifndef _CFEXPFILEHENDLER_H_
#define _CFEXPFILEHENDLER_H_
#include "FEXPCommon.h"
#include "FEXPSerializeData.h"
#include "FEXPConcurency.h"


class ICFEXPFileReaderIntf
{
public:
  virtual Ptr<CFEXPFEInpContBase>       GetInputContainer()       = 0;
  virtual Ptr<std::vector<std::string>> GetFileContent   () const = 0;
  virtual void                          Read             ()       = 0;
  virtual bool                          ReadProgress     ()       = 0;

  // read file and get its content
  static void ReadFileAndGetContent(const std::string & path, std::vector<std::string> & flines)
  {
#define ERROR_RD "Error: File cannot read: "
    std::ifstream file(path);
    if (!file.is_open())
      FEXPCOMMON_EXCEPTION(ERROR_RD + path);
    std::string line = FEXPCOMMON_EMPTY_STRING;
    while (std::getline(file, line))
    {
      CFEXPBaseConvers::StrTrim(line);
      // check empty files or empty data
      if (line == FEXPCOMMON_EMPTY_STRING)
        continue;
      // store line from file
      flines.push_back(line);
    }
    // close file
    file.close();
  }
protected:
  // [no protected members] -----------------------------
private:
  // [no private members  ] -----------------------------
};

// primary template
template<typename TINContainer, typename Enable = void>
class CFEXPFileReader { };
template<typename TINContainer>
class CFEXPFileReader
  // specialization for ICFEXPInpDataContBase based types
  <TINContainer, typename std::enable_if<std::is_base_of<ICFEXPInpDataContBase, TINContainer>::value>::type>
  : public ICFEXPFileReaderIntf
{
public:
  CFEXPFileReader(const std::string & path, const t_FileStructMap & map);
  CFEXPFileReader(const std::string & path, Ptr<std::vector<std::string>> data, const t_FileStructMap & map);
  virtual ~CFEXPFileReader();

  // override methods of interface
  virtual Ptr<CFEXPFEInpContBase>       GetInputContainer()       override;
  virtual Ptr<std::vector<std::string>> GetFileContent   () const override;
  virtual void                          Read             ()       override;
  virtual bool                          ReadProgress     ()       override;

  Ptr<TINContainer> GetInputData();
protected:
  // [no protected members] -----------------------------
private:
  const std::string             _inputpath;
  Ptr<std::vector<std::string>> _content;
  // data container
  bool                          _data_processed;
  Ptr<TINContainer>             _container;
};

// member functions
//--------------------------------------------------------------------------------------
template<typename TINContainer>
CFEXPFileReader<TINContainer, typename std::enable_if<std::is_base_of<ICFEXPInpDataContBase, TINContainer>::value>::type>
  ::CFEXPFileReader(const std::string & path, const t_FileStructMap & map)
  : _inputpath(path), _content(CFEXPDataManager<std::vector<std::string>>::SafeAllocInstance()),
  _data_processed(false), _container(CFEXPDataManager<TINContainer>::SafeAllocInstance(map)) { }
//--------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------
template<typename TINContainer>
CFEXPFileReader<TINContainer, typename std::enable_if<std::is_base_of<ICFEXPInpDataContBase, TINContainer>::value>::type>
  ::CFEXPFileReader(const std::string & path, Ptr<std::vector<std::string>> data, const t_FileStructMap & map)
  : _inputpath(path), _content(data),
  _data_processed(false), _container(CFEXPDataManager<TINContainer>::SafeAllocInstance(map)) { }
//--------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------
template<typename TINContainer>
CFEXPFileReader<TINContainer, typename std::enable_if<std::is_base_of<ICFEXPInpDataContBase, TINContainer>::value>::type>
  ::~CFEXPFileReader() { }
//--------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------
template<typename TINContainer>
Ptr<CFEXPFEInpContBase> CFEXPFileReader<TINContainer, typename std::enable_if<std::is_base_of<ICFEXPInpDataContBase, TINContainer>::value>::type>
  ::GetInputContainer()
//--------------------------------------------------------------------------------------
{
  return FEXPCOMMON_DYNCAST(TINContainer, CFEXPFEInpContBase, _container);
}

//--------------------------------------------------------------------------------------
template<typename TINContainer>
Ptr<std::vector<std::string>> CFEXPFileReader<TINContainer, typename std::enable_if<std::is_base_of<ICFEXPInpDataContBase, TINContainer>::value>::type>
  ::GetFileContent() const
//--------------------------------------------------------------------------------------
{
  auto result = CFEXPDataManager<std::vector<std::string>>::SafeAllocInstance();
  std::copy((*_content.get()).begin(), (*_content.get()).end(), std::back_inserter(*result.get()));
  return result;
}

//--------------------------------------------------------------------------------------
template<typename TINContainer>
void CFEXPFileReader<TINContainer, typename std::enable_if<std::is_base_of<ICFEXPInpDataContBase, TINContainer>::value>::type>
  ::Read()
//--------------------------------------------------------------------------------------
{
  if (_data_processed)
    return;
  // read file and fill content vector
  if(_content->empty())
    ReadFileAndGetContent(_inputpath, *_content.get());
  // create data
  _container->ProcessLines(*_content.get());
  // mark data as already processed
  _data_processed = true;
}

//--------------------------------------------------------------------------------------
template<typename TINContainer>
bool CFEXPFileReader<TINContainer, typename std::enable_if<std::is_base_of<ICFEXPInpDataContBase, TINContainer>::value>::type>
  ::ReadProgress()
//--------------------------------------------------------------------------------------
{
  return CFEXPAsyncRunner::RunProcedureTask([this] { Read(); }, true, "Reading of an input file", true);
}

//--------------------------------------------------------------------------------------
template<typename TINContainer>
Ptr<TINContainer> CFEXPFileReader<TINContainer, typename std::enable_if<std::is_base_of<ICFEXPInpDataContBase, TINContainer>::value>::type>
  ::GetInputData()
//--------------------------------------------------------------------------------------
{
  return _container;
}

#endif // !_CFEXPFILEHENDLER_H_